<html>
<head>
<title>The Bouncy Castle Crypto Package</title>
</head>

<body bgcolor="#ffffff" text="#000000#">

<center>
<h1>The Bouncy Castle Crypto Package</h1>
<font size=1>
<pre>
</pre>
</font>
</center>
The Bouncy Castle Crypto package is a Java implementation of 
cryptographic algorithms, it was developed by the Legion of the
Bouncy Castle - with a little help! The Legion, and the latest
goings on with this package, can be found at
<a href=http://www.bouncycastle.org>http://www.bouncycastle.org</a>. 
<p>
The Legion also gratefully acknowledges the contributions made to this
package by others (see <a href=CONTRIBUTORS.html>here</a>
for the current list). If you would like to contribute to our efforts please feel free to get in touch with us or visit our <a href="https://www.bouncycastle.org/donate">donations page</a> as the Legion of the Bouncy Castle, or more properly Legion of the Bouncy Castle Inc., is now a registered Australian Charity and we are able to accept donations to help fund further work and certifications.
</p>
<p>
The package is organised so that it 
contains a light-weight API suitable for use in any environment
(including the newly released J2ME) with the additional infrastructure
to conform the algorithms to the JCE framework.
</p>
<p>
Except where otherwise stated, this software is distributed under a license based on the MIT X Consortium license.  To view the license, <a href="./LICENSE.html">see here</a>. The OpenPGP library also includes a modified BZIP2 library which is licensed under the <a href="http://www.apache.org/licenses/">Apache Software License, Version 2.0</a>.
</p>
<p>
The current release notes for this package are
<a href="docs/releasenotes.html">here</a>.
</p>
<p>
The current specifications for this package are
<a href="docs/specifications.html">here</a>.
</p>
<p>
The current JavaDoc for the Bouncy Castle APIs can be found
<a href="javadoc/index.html">here</a>.
</p>
<p>
Additional documentation on use of the classes can also be found in the <a href="docs/index.html">docs</a> directory.
</p>
<h2>Examples and Tests</h2>
<p>
		<p>To view some examples, look at the test programs in the packages:
		<ul>
		    <li><p><b>org.bouncycastle.crypto.test</b>
		    <li><p><b>org.bouncycastle.jce.provider.test</b>
		    <li><p><b>org.bouncycastle.cms.test</b>
		    <li><p><b>org.bouncycastle.mail.smime.test</b>
		    <li><p><b>org.bouncycastle.openpgp.test</b>

		    <li><p><b>org.bouncycastle.tsp.test</b>

		</ul>
		<p>There are also some specific example programs for dealing with Attribute Certificates, PKCS12, SMIME and OpenPGP. They can be found in:
		<ul>
			<li><p><b>org.bouncycastle.jce.examples</b>
			<li><p><b>org.bouncycastle.mail.smime.examples</b>
			<li><p><b>org.bouncycastle.openpgp.examples</b>

			<li><p><b>org.bouncycastle.x509.examples</b>
		</ul>

		<p>Finally there are also code <a href="http://www.wiley.com/WileyCDA/WileyAncillary/productCd-0764596330.html">examples</a> from <a href="http://www.amazon.com/exec/obidos/redirect?path=ASIN/0764596330&amp;link_code=as2&amp;camp=1789&amp;tag=bouncycastleo-20&amp;creative=9325">Beginning Cryptography with Java</a> which demonstrate both the use of the JCE/JCA and also some of the Bouncy Castle APIs.</p>
<p>
<b>Note 1:</b>The JCE classes are only distributed with the JDK 1.1, JDK 1.2, and JDK 1.3 JCE releases. The
JDK 1.0, J2ME, and the JDK 1.1, JDK 1.2, JDK 1.3, JDK 1.4, and JDK 1.5 lightweight releases only include the
Bouncy Castle lightweight cryptography API.<br>
<b>Note 2:</b>The regression test for Diffie-Hellman is quite slow.
<h2>Building From CVS</h2>
<p>
The src and test/src directory are for JDK 1.5 on.
</p>
<p>
Compatibility classes for other VMs are as follows:
<ul>
<li>JDK 1.4 - jdk1.4, test/jdk1.4
<li>JDK 1.3 - jdk1.3, test/jdk1.3
<li>JDK 1.2 - jdk1.2 
<li>JDK 1.1 - jdk1.1
<li>JDK 1.0 - jdk1.0
<li>J2ME    - j2me
</ul>
</p>
<p>
The clean room JCE, which will compile with everything from JDK 1.1 and up is in the jce/src/main/java directory.
</p>
<p>
The build scripts that come with the full distribution allow creation of the different releases by using the tree under src and test/src, excluding classes that are not appropriate and copying in the required compatibility classes from the directories containing compatibility classes appropriate for the distribution.
</p>
<p>
If you want to try create a build for yourself, using your own environment, the best way to do it is to start with the build for the distribution you are interested in, make sure that builds, and then modify your build scripts to do the required exclusions and file copies for your setup, otherwise you are likely to get class not found exceptions. The final caveat to this is that as the j2me distribution includes some compatibility classes starting in the java package, you need to use an obfuscator to change the package names before attempting to import a midlet using the BC API.
</p>
<h2>Mailing Lists</h2>
<p>
For those who are interested, there are 2 mailing lists
for participation in this project.  To subscribe use the
links below and include the word subscribe in the message body.  (To unsubscribe, replace <b>subscribe</b> with
<b>unsubscribe</b> in the message body)
<ul>
<li><a href="mailto:announce-crypto-request@bouncycastle.org">announce-crypto-request@bouncycastle.org</a>
<br>
This mailing list is for new release announcements only, general subscribers cannot post to it.
<p>
<li><a href="mailto:dev-crypto-request@bouncycastle.org">dev-crypto-request@bouncycastle.org</a>
<br>
This mailing list is for discussion of development of the package.  This
includes bugs, comments, requests for enhancements, questions about 
use or operation.
</ul>
<b>NOTE:</b>You need to be subscribed to send mail to the above
mailing list.
<p>
If you want to provide feedback, offers of jobs (or more importantly 
beer) directly to the members of <b>The Legion</b>
then please use <a href="mailto:feedback-crypto@bouncycastle.org">
feedback-crypto@bouncycastle.org</a>
<p>
Enjoy!
</body>
</html>
